/*
 * File     : StructureInfo.java
 * Created  : 1 May 2011
 *
 * Copyright © 2011 Matthew Wilson (mj. {my-surname} .uk {at} gmail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.googlecode.dni.type.structure;

/**
 * <p>
 *  Encapsulates information about a structure.
 * </p>
 *
 * @author Matthew Wilson
 */
public final class StructureInfo
{

    private final int size;

    private final boolean opaque;

    /**
     * @param size
     *            the size of the structure
     * @param opaque
     *            whether opaque
     */
    public StructureInfo( final int size,
                          final boolean opaque )
    {
        if ( size < 0 )
        {
            this.size = -1;
        }
        else
        {
            this.size = size;
        }
        this.opaque = opaque;

        assert !this.opaque || this.size == -1;
    }

    /**
     * @return the size of the structure, in bytes;
     *         -1 if unknown
     */
    public int getSize()
    {
        return this.size;
    }

    /**
     * @return whether opaque
     */
    public boolean isOpaque()
    {
        return this.opaque;
    }

    /** {@inheritDoc} */
    @Override
    public String toString()
    {
        return "StructureInfo[size=" + this.size + ",opaque=" + this.opaque + "]";
    }

}
